GetControlTitle

GetControlTitle
Header:	Controls.h		Carbon status:	Supported

Obtains the title of a control.

void GetControlTitle (
    ControlRef theControl, 
    Str255 title
);

Parameter descriptions

theControl: A handle to the control whose title you want to determine.
title: On input, a pascal string. On output, the title of the control.

DISCUSSION

The GetControlTitle function produces the title of the specified control, which is stored in the contrlTitle field of the control structure.

When you create a control, you specify an initial title either in the control resource or in the title parameter of the function NewControl. You can change the title by using SetControlTitle.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.